chore: integrate vitest matchers globally #3425
Conversation
starc007
requested review from
digorithm,
arboleya,
Torres-ssf,
Dhaiwat10,
danielbate,
nedsalk,
petertonysmith94 and
maschad
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
|
|
@starc007 is attempting to deploy a commit to the Fuel Labs Team on Vercel. A member of the Team first needs to authorize it. |
CodSpeed Performance ReportMerging #3425 will improve performances by 47.93%Comparing Summary
Benchmarks breakdown
|
There was a problem hiding this comment.
Hey @starc007,
Thank you so much for this contribution. We really appreciate it 🙏
It appears that the current solution hasn’t resolved the TS errors.
Torres-ssf
added
chore
Torres-ssf
changed the title
There was a problem hiding this comment.
This PR also needs a changeset, please run pnpm changeset from the root directory.
starc007
force-pushed
the
starc007/feat/integrate-vitest-matchers-globally
branch
from
5b0f72a
to
b70acc1
Compare
|
Hey @Torres-ssf Issue: This suggests the Questions:
Any guidance on the correct way to set this up would be appreciated. |
| }, | ||
| "include": ["src", "test"] | ||
| "include": ["src", "global.d.ts"] |
There was a problem hiding this comment.
| "include": ["src", "global.d.ts"] | |
| "include": ["src", "test", "global.d.ts"] |
We want to include the test directory still.
| interface Matchers<R = BN> { | ||
| toEqualBn: (expected: BNInput) => R; | ||
| } | ||
|
|
||
| const pass = received.eq(argument); | ||
|
|
||
| if (pass) { | ||
| return { | ||
| message: () => `Expected ${received.toString()} not to equal ${argument.toString()}`, | ||
| pass: true, | ||
| }; | ||
| declare module 'vitest' { | ||
| interface Assertion extends Matchers {} | ||
| interface AsymmetricMatchersContaining extends Matchers {} | ||
| interface ExpectStatic { | ||
| toEqualBn(expected: BNInput): BN; | ||
| } | ||
| return { | ||
| message: () => `expected ${received.toString()} to equal ${argument.toString()}`, | ||
| pass: false, | ||
| }; | ||
| } |
There was a problem hiding this comment.
- Replace the contents of
packages/fuel-gauge/test/global.d.tswith this. - Add the following to the
tsconfig.test.json
git cherry-pick 8ed2d14d5f57581746b260b4d83364af3a01c479.
I believe this should resolve the linting issue.
| import { setupTestMatchers } from './src/abi/vitest.matcher'; | ||
|
|
||
| setupTestMatchers(); |
There was a problem hiding this comment.
Could we move the contents of vitest.matcher to this file?
| @@ -0,0 +1,5 @@ | |||
| --- | |||
| "fuels": minor | |||
There was a problem hiding this comment.
| "fuels": minor |
There are no changes to fuels.
There was a problem hiding this comment.
Ideally this won't live in fuel-gauge which is our integration testing directory, vitest config should live outside here and be usable throughout the SDK.
There was a problem hiding this comment.
I agree with @danielbate. These new matchers should be accessible for use in tests across any package.
The issue is that the created matchers rely on types imported from the math package. Ideally, these matchers should not depend on imported types.
There was a problem hiding this comment.
We could move the setup to packages/utils/src/test-utils as @fuel-ts/utils is available at the root level as a devDependency.
It could also be helpful to end consumers.
There was a problem hiding this comment.
yaa that location makes sense since @fuel-ts/utils is available as a root devDependency and would make these matchers accessible across packages.
let me know if we want to go this way
There was a problem hiding this comment.
Go for it @starc007 - makes sense to me :)
Will convert to draft until you're ready.
vitestmatchers globally #3421Summary
This PR integrates Vitest matchers globally for fuel-gauge tests, improving test maintainability and type safety.
Changes
test/setup.tstoEqualBnexpect.extend()calls from test files@ts-expect-errorcomments fortoEqualBnusageTesting